Skip to content

Add auditable_type and auditable_id properties to Audit Model #1025

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
May 21, 2025
Merged

Add auditable_type and auditable_id properties to Audit Model #1025

merged 2 commits into from
May 21, 2025

Conversation

aSeriousDeveloper
Copy link
Contributor

@aSeriousDeveloper aSeriousDeveloper commented May 21, 2025 •
edited
Loading

EDIT: imported Carbon, apparently I missed that last time. Sorry 😬

Hi, Another addition to the Audit docblock to help with PHPStan type hinting.

This one is to add the auditable_type and auditable_id columns used for the auditable relation so they can be selcted, plucked, etc. The reason for this is an example below:

Audit::query()->distinct()->pluck('auditable_type');

In PHPStan levels 7 and above, this gives the following error:

 ------ ----------------------------------------------------------------------------- 
  Line   Filament/AuditResource.php                                                   
 ------ ----------------------------------------------------------------------------- 
  241    Parameter #1 $column of method                                               
         Illuminate\Database\Eloquent\Builder<OwenIt\Auditing\Models\Audit>::pluck()  
         expects Illuminate\Contracts\Database\Query\Expression|model property        
         of OwenIt\Auditing\Models\Audit, string given.                               
         🪪 argument.type                                                             
         💡 Type #2 from the union: The given string should be a property of          
            OwenIt\Auditing\Models\Audit, auditable_type given.                       
 ------ -----------------------------------------------------------------------------

Adding the properties to the Audit model resolves this. From looking at the migration stub, the morphable prefix for the auditable column cannot be changed so there shouldn't be a risk of these type hinted properties being incorrect.

User Properties

I haven't made the same change for the user relation. The reason why is that the config (and migration) allows for altering the prefix of the user morph column.

laravel-auditing/config/audit.php

Lines 27 to 34 in c57fbec

'user' => [
'morph_prefix' => 'user',
'guards' => [
'web',
'api',
],
'resolver' => OwenIt\Auditing\Resolvers\UserResolver::class,
],

laravel-auditing/database/migrations/audits.stub

Lines 21 to 24 in c57fbec

$table->bigIncrements('id');
$table->string($morphPrefix . '_type')->nullable();
$table->unsignedBigInteger($morphPrefix . '_id')->nullable();
$table->string('event');

Therefore, trying to type hint them would be unreliable, as they can be changed.

@erikn69 erikn69 merged commit 0f67b52 into owen-it:master May 21, 2025
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@erikn69 erikn69 erikn69 approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@aSeriousDeveloper @erikn69